<!DOCTYPE html>

<html>
<head>
<meta charset="UTF-8">

<title>module AboutYou::SDK::Model::AbstractBasketItem - RDoc Documentation</title>

<link href="../../../fonts.css" rel="stylesheet">
<link href="../../../rdoc.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../../../";
</script>

<script src="../../../js/jquery.js"></script>
<script src="../../../js/navigation.js"></script>
<script src="../../../js/search_index.js"></script>
<script src="../../../js/search.js"></script>
<script src="../../../js/searcher.js"></script>
<script src="../../../js/darkfish.js"></script>


<body id="top" role="document" class="module">
<nav role="navigation">
  <div id="project-navigation">
    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2>
    <a href="../../../index.html" rel="home">Home</a>
  </h2>

  <div id="table-of-contents-navigation">
    <a href="../../../table_of_contents.html#pages">Pages</a>
    <a href="../../../table_of_contents.html#classes">Classes</a>
    <a href="../../../table_of_contents.html#methods">Methods</a>
  </div>
</div>

    <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

  </div>

  

  <div id="class-metadata">
    
    
    
    
    <!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    
    <li ><a href="#method-i-addition_data-3D">#addition_data=</a>
    
    <li ><a href="#method-i-check_additional_data">#check_additional_data</a>
    
    <li ><a href="#method-i-description">#description</a>
    
  </ul>
</div>

  </div>
</nav>

<main role="main" aria-labelledby="module-AboutYou::SDK::Model::AbstractBasketItem">
  <h1 id="module-AboutYou::SDK::Model::AbstractBasketItem" class="module">
    module AboutYou::SDK::Model::AbstractBasketItem
  </h1>

  <section class="description">
    
<p>This class is an abstract model of a basket item</p>
<dl class="rdoc-list note-list"><dt>author
<dd>
<p>Collins GmbH &amp; Co KG</p>
</dd></dl>

  </section>

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    
    <section class="constants-list">
      <header>
        <h3>Constants</h3>
      </header>
      <dl>
      
        <dt id="IMAGE_URL_REQUIRED">IMAGE_URL_REQUIRED
        
        <dd><p>determines if the image url is required</p>
        
      
      </dl>
    </section>
    

    
    <section class="attribute-method-details" class="method-section">
      <header>
        <h3>Attributes</h3>
      </header>

      
      <div id="attribute-i-additional_data" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">additional_data</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Additional data</p>
        
        </div>
      </div>
      
      <div id="attribute-i-is_changed" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">is_changed</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>determines whether a basket item is changed or not</p>
        
        </div>
      </div>
      
    </section>
    

    
     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Public Instance Methods</h3>
       </header>

    
      <div id="method-i-addition_data-3D" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">addition_data=</span><span
            class="method-args">(additional_data)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>sets additional data for the basket item</p>
<ul><li>
<p><strong>Args</strong>    :</p>
<ul><li>
<p><code>additional_data</code> -&gt; the desired data to set</p>
</li></ul>
</li></ul>
          
          

          
          <div class="method-source-code" id="addition_data-3D-source">
            <pre><span class="ruby-comment"># File lib/AboutYou/Model/Basket/abstract_basket_item.rb, line 34</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">addition_data=</span>(<span class="ruby-identifier">additional_data</span>)
  <span class="ruby-identifier">check_additional_data</span>(<span class="ruby-identifier">additional_data</span>)
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_changed</span> = <span class="ruby-keyword">true</span>

  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">additional_data</span> = <span class="ruby-identifier">additional_data</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-check_additional_data" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">check_additional_data</span><span
            class="method-args">(additional_data = nil)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>checks if certain <a
href="AbstractBasketItem.html#attribute-i-additional_data">#additional_data</a>
is valid to set for a basket item or not</p>
<ul><li>
<p><strong>Args</strong>    :</p>
<ul><li>
<p><code>additional_data</code> -&gt; the desired data to check</p>
</li></ul>
</li><li>
<p><strong>Fails</strong> :</p>
<ul><li>
<p>if <a
href="AbstractBasketItem.html#attribute-i-additional_data">#additional_data</a>
doesnt have a description</p>
</li><li>
<p>if <a
href="AbstractBasketItem.html#attribute-i-additional_data">#additional_data</a>
doesnt have an image url and it would be required</p>
</li></ul>
</li></ul>
          
          

          
          <div class="method-source-code" id="check_additional_data-source">
            <pre><span class="ruby-comment"># File lib/AboutYou/Model/Basket/abstract_basket_item.rb, line 51</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">check_additional_data</span>(<span class="ruby-identifier">additional_data</span> = <span class="ruby-keyword">nil</span>)
  <span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">additional_data</span> <span class="ruby-operator">||</span> <span class="ruby-constant">IMAGE_URL_REQUIRED</span>
  <span class="ruby-identifier">fail</span> <span class="ruby-string">'InvalidArgumentException! description is required
    in additional data'</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">additional_data</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-string">'description'</span>)
  <span class="ruby-identifier">fail</span> <span class="ruby-string">'InvalidArgumentException! image_url is required in
    additional data'</span> <span class="ruby-keyword">if</span>
    <span class="ruby-constant">IMAGE_URL_REQUIRED</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">additional_data</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-string">'image_url'</span>)
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-description" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">description</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>gets the description of the basket item</p>
<ul><li>
<p><strong>Returns</strong> :</p>
<ul><li>
<p>a String of null if no description is set</p>
</li></ul>
</li></ul>
          
          

          
          <div class="method-source-code" id="description-source">
            <pre><span class="ruby-comment"># File lib/AboutYou/Model/Basket/abstract_basket_item.rb, line 24</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">description</span>
  <span class="ruby-identifier">additional_data</span>[<span class="ruby-string">'description'</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">additional_data</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
    </section>
  
  </section>
</main>


<footer id="validator-badges" role="contentinfo">
  <p><a href="http://validator.w3.org/check/referer">Validate</a>
  <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.2.
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

